Cisco-IOS-XR-eigrp-cfg API API Reference
API generated from Cisco-IOS-XR-eigrp-cfg@2018-06-15.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key Mandatory OptionalPaths
EIGRP - Update
Update operation of resource: eigrp
eigrpbody object
Request Content-Types: application/json
Request Example
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EIGRP - Create
Create operation of resource: eigrp
eigrpbody object
Request Content-Types: application/json
Request Example
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EIGRP - Delete
Delete operation of resource: eigrp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EIGRP - Retrieve
Retrieve operation of resource: eigrp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
}
PROCESSES - Update
Update operation of resource: processes
processesbody object
Request Content-Types: application/json
Request Example
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESSES - Create
Create operation of resource: processes
processesbody object
Request Content-Types: application/json
Request Example
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESSES - Delete
Delete operation of resource: processes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESSES - Retrieve
Retrieve operation of resource: processes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
]
}
}
PROCESS - Update
Update operation of resource: process
processbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ "nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESS - Create
Create operation of resource: process
processbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ "nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESS - Delete
Delete operation of resource: process
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROCESS - Retrieve
Retrieve operation of resource: process
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "nsf-disable": [ null ], Disable NSF for this address family under this\nVRF : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}, {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
},
"process-id": "string" AS number (1 - 65535) or Virutual instance\nname of the EIGRP process
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name
"enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
]
}
AFS - Update
Update operation of resource: afs
afsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}, {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6 "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
},
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}, "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
},
"maximum-paths": "integer", number of paths
range: "1..32" {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
ALL-NEIGHBORS-MAXIMUM-PREFIX - Update
Update operation of resource: all-neighbors-maximum-prefix
all-neighbors-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ALL-NEIGHBORS-MAXIMUM-PREFIX - Create
Create operation of resource: all-neighbors-maximum-prefix
all-neighbors-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ALL-NEIGHBORS-MAXIMUM-PREFIX - Delete
Delete operation of resource: all-neighbors-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ALL-NEIGHBORS-MAXIMUM-PREFIX - Retrieve
Retrieve operation of resource: all-neighbors-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
REDIST-MAXIMUM-PREFIX - Update
Update operation of resource: redist-maximum-prefix
redist-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDIST-MAXIMUM-PREFIX - Create
Create operation of resource: redist-maximum-prefix
redist-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDIST-MAXIMUM-PREFIX - Delete
Delete operation of resource: redist-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDIST-MAXIMUM-PREFIX - Retrieve
Retrieve operation of resource: redist-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "integer", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
NEIGHBOR-MAXIMUM-PREFIXES - Update
Update operation of resource: neighbor-maximum-prefixes
neighbor-maximum-prefixesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIXES - Create
Create operation of resource: neighbor-maximum-prefixes
neighbor-maximum-prefixesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIXES - Delete
Delete operation of resource: neighbor-maximum-prefixes
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIXES - Retrieve
Retrieve operation of resource: neighbor-maximum-prefixes
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
]
}
}
NEIGHBOR-MAXIMUM-PREFIX - Update
Update operation of resource: neighbor-maximum-prefix
neighbor-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
neighbor-address:
string
in path
ID of neighbor-address
Request Content-Types: application/json
Request Example
{ "threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIX - Create
Create operation of resource: neighbor-maximum-prefix
neighbor-maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
neighbor-address:
string
in path
ID of neighbor-address
Request Content-Types: application/json
Request Example
{ "threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIX - Delete
Delete operation of resource: neighbor-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NEIGHBOR-MAXIMUM-PREFIX - Retrieve
Retrieve operation of resource: neighbor-maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"neighbor-address": "string", Neighbor IP address
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"max-prefix": "integer" Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
}
}
MAXIMUM-PREFIX - Update
Update operation of resource: maximum-prefix
maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAXIMUM-PREFIX - Create
Create operation of resource: maximum-prefix
maximum-prefixbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAXIMUM-PREFIX - Delete
Delete operation of resource: maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAXIMUM-PREFIX - Retrieve
Retrieve operation of resource: maximum-prefix
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-prefix": "integer", Number of IP prefixes for maximum-prefix\nlimit
range: "1..4294967295"
"dampened": "boolean", Enable decay penalty to be applied to\ntime period
"warning-only": "boolean", Only a warning is logged when prefix\nlimit is reached
"restart": "integer", Shutdown time after hitting max-prefix\nlimit
"threshold": "integer", Configure threshold percentage for\nwarnings
range: "1..100"
units: "percentage"
"restart-count": "integer", Restart count after hitting max-prefix\nlimit
"reset-time": "integer" Time to reset restart count
}
}
STUB - Update
Update operation of resource: stub
stubbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Create
Create operation of resource: stub
stubbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Delete
Delete operation of resource: stub
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Retrieve
Retrieve operation of resource: stub
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
REDISTRIBUTES - Update
Update operation of resource: redistributes
redistributesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Create
Create operation of resource: redistributes
redistributesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Delete
Delete operation of resource: redistributes
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Retrieve
Retrieve operation of resource: redistributes
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
REDISTRIBUTE - Update
Update operation of resource: redistribute
redistributebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Create
Create operation of resource: redistribute
redistributebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Delete
Delete operation of resource: redistribute
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Retrieve
Retrieve operation of resource: redistribute
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
REDISTRIBUTE-AS-XX - Update
Update operation of resource: redistribute-as-xx
redistribute-as-xxbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Create
Create operation of resource: redistribute-as-xx
redistribute-as-xxbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Delete
Delete operation of resource: redistribute-as-xx
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Retrieve
Retrieve operation of resource: redistribute-as-xx
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-YY - Update
Update operation of resource: redistribute-as-yy
redistribute-as-yybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Create
Create operation of resource: redistribute-as-yy
redistribute-as-yybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Delete
Delete operation of resource: redistribute-as-yy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Retrieve
Retrieve operation of resource: redistribute-as-yy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-AS-XX-AS-YY - Update
Update operation of resource: redistribute-as-xx-as-yy
redistribute-as-xx-as-yybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Create
Create operation of resource: redistribute-as-xx-as-yy
redistribute-as-xx-as-yybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Delete
Delete operation of resource: redistribute-as-xx-as-yy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Retrieve
Retrieve operation of resource: redistribute-as-xx-as-yy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-TAG-NAME - Update
Update operation of resource: redistribute-tag-name
redistribute-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Create
Create operation of resource: redistribute-tag-name
redistribute-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Delete
Delete operation of resource: redistribute-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-XX-TAG-NAME - Update
Update operation of resource: redistribute-as-xx-tag-name
redistribute-as-xx-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Create
Create operation of resource: redistribute-as-xx-tag-name
redistribute-as-xx-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Delete
Delete operation of resource: redistribute-as-xx-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-xx-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-YY-TAG-NAME - Update
Update operation of resource: redistribute-as-yy-tag-name
redistribute-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Create
Create operation of resource: redistribute-as-yy-tag-name
redistribute-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Delete
Delete operation of resource: redistribute-as-yy-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-yy-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Update
Update operation of resource: redistribute-as-xx-as-yy-tag-name
redistribute-as-xx-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Create
Create operation of resource: redistribute-as-xx-as-yy-tag-name
redistribute-as-xx-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Delete
Delete operation of resource: redistribute-as-xx-as-yy-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-xx-as-yy-tag-name
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
FILTER-POLICIES - Update
Update operation of resource: filter-policies
filter-policiesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Create
Create operation of resource: filter-policies
filter-policiesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Delete
Delete operation of resource: filter-policies
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Retrieve
Retrieve operation of resource: filter-policies
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
FILTER-POLICY - Update
Update operation of resource: filter-policy
filter-policybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Create
Create operation of resource: filter-policy
filter-policybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Delete
Delete operation of resource: filter-policy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Retrieve
Retrieve operation of resource: filter-policy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
DEFAULT-METRIC - Update
Update operation of resource: default-metric
default-metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Create
Create operation of resource: default-metric
default-metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Delete
Delete operation of resource: default-metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Retrieve
Retrieve operation of resource: default-metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
METRICS - Update
Update operation of resource: metrics
metricsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Create
Create operation of resource: metrics
metricsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Delete
Delete operation of resource: metrics
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Retrieve
Retrieve operation of resource: metrics
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
METRIC - Update
Update operation of resource: metric
metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Create
Create operation of resource: metric
metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Delete
Delete operation of resource: metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Retrieve
Retrieve operation of resource: metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
TIMERS - Update
Update operation of resource: timers
timersbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
TIMER - Update
Update operation of resource: timer
timerbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Create
Create operation of resource: timer
timerbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Delete
Delete operation of resource: timer
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Retrieve
Retrieve operation of resource: timer
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
DEFAULT-ACCEPTS - Update
Update operation of resource: default-accepts
default-acceptsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Create
Create operation of resource: default-accepts
default-acceptsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Delete
Delete operation of resource: default-accepts
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Retrieve
Retrieve operation of resource: default-accepts
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
DEFAULT-ACCEPT - Update
Update operation of resource: default-accept
default-acceptbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Create
Create operation of resource: default-accept
default-acceptbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Delete
Delete operation of resource: default-accept
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Retrieve
Retrieve operation of resource: default-accept
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
INTERFACE-METRIC - Update
Update operation of resource: interface-metric
interface-metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Create
Create operation of resource: interface-metric
interface-metricbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Delete
Delete operation of resource: interface-metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Retrieve
Retrieve operation of resource: interface-metric
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
REMOTE-NEIGHBOR - Update
Update operation of resource: remote-neighbor
remote-neighborbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Create
Create operation of resource: remote-neighbor
remote-neighborbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Delete
Delete operation of resource: remote-neighbor
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Retrieve
Retrieve operation of resource: remote-neighbor
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
BFD - Update
Update operation of resource: bfd
bfdbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
SITE-OF-ORIGIN - Update
Update operation of resource: site-of-origin
site-of-originbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Create
Create operation of resource: site-of-origin
site-of-originbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Delete
Delete operation of resource: site-of-origin
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Retrieve
Retrieve operation of resource: site-of-origin
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
SUMMARY-ADDRESSES - Update
Update operation of resource: summary-addresses
summary-addressesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Create
Create operation of resource: summary-addresses
summary-addressesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Delete
Delete operation of resource: summary-addresses
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Retrieve
Retrieve operation of resource: summary-addresses
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
SUMMARY-ADDRESS - Update
Update operation of resource: summary-address
summary-addressbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
Request Content-Types: application/json
Request Example
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Create
Create operation of resource: summary-address
summary-addressbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
Request Content-Types: application/json
Request Example
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Delete
Delete operation of resource: summary-address
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Retrieve
Retrieve operation of resource: summary-address
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
INTERFACE-FILTER-POLICIES - Update
Update operation of resource: interface-filter-policies
interface-filter-policiesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Create
Create operation of resource: interface-filter-policies
interface-filter-policiesbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Delete
Delete operation of resource: interface-filter-policies
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Retrieve
Retrieve operation of resource: interface-filter-policies
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
INTERFACE-FILTER-POLICY - Update
Update operation of resource: interface-filter-policy
interface-filter-policybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Create
Create operation of resource: interface-filter-policy
interface-filter-policybody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Delete
Delete operation of resource: interface-filter-policy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Retrieve
Retrieve operation of resource: interface-filter-policy
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
Successful operation
400 Bad Request
Internal Error
INTERFACE-STATIC-NEIGHBORS - Update
Update operation of resource: interface-static-neighbors
interface-static-neighborsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Create
Create operation of resource: interface-static-neighbors
interface-static-neighborsbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Delete
Delete operation of resource: interface-static-neighbors
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Retrieve
Retrieve operation of resource: interface-static-neighbors
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
INTERFACE-STATIC-NEIGHBOR - Update
Update operation of resource: interface-static-neighbor
interface-static-neighborbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Create
Create operation of resource: interface-static-neighbor
interface-static-neighborbody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Delete
Delete operation of resource: interface-static-neighbor
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-static-neighbor
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
DISTANCE - Update
Update operation of resource: distance
distancebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Create
Create operation of resource: distance
distancebody object
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Delete
Delete operation of resource: distance
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Retrieve
Retrieve operation of resource: distance
process-id:
string
in path
ID of process-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "enable": [ null ], Enable Interface configuration {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
}
DEFAULT-AFS - Update
Update operation of resource: default-afs
default-afsbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AFS - Create
Create operation of resource: default-afs
default-afsbody object
process-id:
string
in path
ID of process-id
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AFS - Delete
Delete operation of resource: default-afs
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AFS - Retrieve
Retrieve operation of resource: default-afs
process-id:
string
in path
ID of process-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
}
DEFAULT-AF - Update
Update operation of resource: default-af
default-afbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AF - Create
Create operation of resource: default-af
default-afbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AF - Delete
Delete operation of resource: default-af
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-AF - Retrieve
Retrieve operation of resource: default-af
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], Enable Interface configuration {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
},
"af-name": "enumeration", Address Family
Options:
ipv4
ipv6
"maximum-paths": "integer", number of paths
range: "1..32" { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Set distance for EIGRP routes
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" Stub config type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Hop count
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
},
"passive-interface-default": [ null ], Suppress routing updates on all interfaces {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
},
"variance": "integer", Control load balancing variance
range: "1..128"
"nsf-disable": [ null ], Disable NSF for this address family under this\nVRF
"log-neighbor-warnings": [ null ], Enable/Disable neighbor state change warnings "internal-distance": "integer", Internal routes' distance
range: "1..255"
"external-distance": "integer" External routes' distance
range: "1..255"
}, "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
},
"autonomous-system": "integer", Set the autonomous system of a VRF
range: "1..65535"
"router-id": "string", Set router ID "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
},
"auto-summary": [ null ], Enable Auto Summarization {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
},
"log-neighbor-changes": [ null ], Enable/Disable logginf of neighbor state changes {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
}
}
]
}
STUB - Update
Update operation of resource: stub
stubbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Create
Create operation of resource: stub
stubbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Delete
Delete operation of resource: stub
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STUB - Retrieve
Retrieve operation of resource: stub
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "connected": "boolean", Do advertise connected routes
"static": "boolean", Do advertise static routes
"redistributed": "boolean", Do advertise redistributed routes
"type": "enumeration", Stub config type
Options:
receive-only
filtered
"summary": "boolean" Do advertise summary routes
}
}
REDISTRIBUTES - Update
Update operation of resource: redistributes
redistributesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Create
Create operation of resource: redistributes
redistributesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Delete
Delete operation of resource: redistributes
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Retrieve
Retrieve operation of resource: redistributes
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
}
REDISTRIBUTE - Update
Update operation of resource: redistribute
redistributebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Create
Create operation of resource: redistribute
redistributebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Delete
Delete operation of resource: redistribute
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Retrieve
Retrieve operation of resource: redistribute
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
protocol-name:
string
in path
ID of protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
], {
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
]
}
REDISTRIBUTE-AS-XX - Update
Update operation of resource: redistribute-as-xx
redistribute-as-xxbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Create
Create operation of resource: redistribute-as-xx
redistribute-as-xxbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Delete
Delete operation of resource: redistribute-as-xx
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX - Retrieve
Retrieve operation of resource: redistribute-as-xx
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx protocol-name:
string
in path
ID of as-xx protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-YY - Update
Update operation of resource: redistribute-as-yy
redistribute-as-yybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Create
Create operation of resource: redistribute-as-yy
redistribute-as-yybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Delete
Delete operation of resource: redistribute-as-yy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY - Retrieve
Retrieve operation of resource: redistribute-as-yy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy protocol-name:
string
in path
ID of as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-AS-XX-AS-YY - Update
Update operation of resource: redistribute-as-xx-as-yy
redistribute-as-xx-as-yybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Create
Create operation of resource: redistribute-as-xx-as-yy
redistribute-as-xx-as-yybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Delete
Delete operation of resource: redistribute-as-xx-as-yy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY - Retrieve
Retrieve operation of resource: redistribute-as-xx-as-yy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy protocol-name:
string
in path
ID of as-xx as-yy protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-TAG-NAME - Update
Update operation of resource: redistribute-tag-name
redistribute-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Create
Create operation of resource: redistribute-tag-name
redistribute-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Delete
Delete operation of resource: redistribute-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
tag-name protocol-name:
string
in path
ID of tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-XX-TAG-NAME - Update
Update operation of resource: redistribute-as-xx-tag-name
redistribute-as-xx-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Create
Create operation of resource: redistribute-as-xx-tag-name
redistribute-as-xx-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Delete
Delete operation of resource: redistribute-as-xx-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-xx-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx tag-name protocol-name:
string
in path
ID of as-xx tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
REDISTRIBUTE-AS-YY-TAG-NAME - Update
Update operation of resource: redistribute-as-yy-tag-name
redistribute-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Create
Create operation of resource: redistribute-as-yy-tag-name
redistribute-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Delete
Delete operation of resource: redistribute-as-yy-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-YY-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-yy-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-yy tag-name protocol-name:
string
in path
ID of as-yy tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"protocol-name": "enumeration", Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
"as-yy": "integer" 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
}
}
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Update
Update operation of resource: redistribute-as-xx-as-yy-tag-name
redistribute-as-xx-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Create
Create operation of resource: redistribute-as-xx-as-yy-tag-name
redistribute-as-xx-as-yy-tag-namebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Request Content-Types: application/json
Request Example
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Delete
Delete operation of resource: redistribute-as-xx-as-yy-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REDISTRIBUTE-AS-XX-AS-YY-TAG-NAME - Retrieve
Retrieve operation of resource: redistribute-as-xx-as-yy-tag-name
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
as-xx as-yy tag-name protocol-name:
string
in path
ID of as-xx as-yy tag-name protocol-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "as-xx": "integer", Higher sixteen bits of 4-byte BGP AS number
range: "0..65535"
"tag-name": "string", OSPF/OSPFv3/ISIS/OnePK Application tag name
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"policy-name": "string", Policy name
"policy-specified": "boolean", TRUE if Policy has been specified
"protocol-name": "enumeration" Redistributed protocol
Options:
bgp
connected
eigrp
isis
ospf
rip
static
ospfv3
subscriber
application
mobile
}
}
FILTER-POLICIES - Update
Update operation of resource: filter-policies
filter-policiesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Create
Create operation of resource: filter-policies
filter-policiesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Delete
Delete operation of resource: filter-policies
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICIES - Retrieve
Retrieve operation of resource: filter-policies
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
FILTER-POLICY - Update
Update operation of resource: filter-policy
filter-policybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Create
Create operation of resource: filter-policy
filter-policybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Delete
Delete operation of resource: filter-policy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FILTER-POLICY - Retrieve
Retrieve operation of resource: filter-policy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
DEFAULT-METRIC - Update
Update operation of resource: default-metric
default-metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Create
Create operation of resource: default-metric
default-metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Delete
Delete operation of resource: default-metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-METRIC - Retrieve
Retrieve operation of resource: default-metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delay": "integer", Delay metric, in 10 microsecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where 255\nis 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"mtu": "integer" Maximum Transmission Unit metric of the path
range: "1..65535"
}
}
METRICS - Update
Update operation of resource: metrics
metricsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Create
Create operation of resource: metrics
metricsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Delete
Delete operation of resource: metrics
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRICS - Retrieve
Retrieve operation of resource: metrics
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
}
METRIC - Update
Update operation of resource: metric
metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Create
Create operation of resource: metric
metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
Request Content-Types: application/json
Request Example
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Delete
Delete operation of resource: metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC - Retrieve
Retrieve operation of resource: metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
metric-name:
string
in path
ID of metric-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tos": "integer", Type of Service (Only TOS 0 supported)
range: "0"
"metric-name": "enumeration", Type of metric change
Options:
maximum-hops
weights
rib-scale
version
"k3": "integer", K3
range: "0..255"
"k2": "integer", K2
range: "0..255"
"k1": "integer", K1
range: "0..255"
"k6": "integer", K6
range: "0..255"
"k5": "integer", K5
range: "0..255"
"k4": "integer", K4
range: "0..255"
"metric-version": "enumeration", Metric version
Options:
64bit
32bit
"max-hops": "integer", Hop count
range: "1..255"
"rib-scale": "integer" RIB scale
range: "1..4294967295"
}
]
}
TIMERS - Update
Update operation of resource: timers
timersbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
}
TIMER - Update
Update operation of resource: timer
timerbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Create
Create operation of resource: timer
timerbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
Request Content-Types: application/json
Request Example
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Delete
Delete operation of resource: timer
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TIMER - Retrieve
Retrieve operation of resource: timer
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
timer-type:
string
in path
ID of timer-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"hold-time": "integer", Hold time (in seconds)
range: "20..6000"
units: "second"
"timer-type": "enumeration", Type of timer
Options:
active
route-hold
signal
converge
"signal-time": "integer", Signal time (in seconds)
range: "10..30"
units: "second"
"converge-time": "integer", Converge time (in seconds)
range: "60..5000"
units: "second"
"active-time": "integer" Active Time (in seconds)
units: "second"
}
]
}
DEFAULT-ACCEPTS - Update
Update operation of resource: default-accepts
default-acceptsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Create
Create operation of resource: default-accepts
default-acceptsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Delete
Delete operation of resource: default-accepts
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPTS - Retrieve
Retrieve operation of resource: default-accepts
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"policy-name": "string", Policy name
"direction": "enumeration", Direction (in or out)
Options:
in
out
"policy-specified": "boolean" TRUE if Policy has been specified
}
]
}
}
DEFAULT-ACCEPT - Update
Update operation of resource: default-accept
default-acceptbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Create
Create operation of resource: default-accept
default-acceptbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Delete
Delete operation of resource: default-accept
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ACCEPT - Retrieve
Retrieve operation of resource: default-accept
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "max-neighbors": "integer", Neighbor count
range: "1..65535"
"enable": "boolean", Enable Interface configuration
"allow-list": "string" Policy name
},
"enable": [ null ], Enable Interface configuration
"hello-interval": "integer", Interval (in seconds)
range: "1..65535"
units: "second" {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
},
"passive-interface": "boolean", Suppress routing updates on an interface "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}, "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}, {
"policy-name": "string", Policy name
"direction": "enumeration" Direction (in or out)
Options:
in
out
}
]
},
"interface-name": "string", Interface name "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
},
"next-hop-self": [ null ], Disable next-hop-self {
"neighbor-address": "string", Neighbor IP address
"max-hops": "integer" Number of hops
range: "2..100"
}
]
}, "keychain": "string" Authentication keychain configuration
},
"split-horizon": [ null ], Configure split horizon behaviour
"hold-time": "integer", Neighbor hold time (in seconds)
range: "1..65535"
units: "second"
"bandwidth-percent": "integer" Bandwidth limit
range: "1..999999"
units: "percentage"
}
]
}
INTERFACE-METRIC - Update
Update operation of resource: interface-metric
interface-metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Create
Create operation of resource: interface-metric
interface-metricbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Delete
Delete operation of resource: interface-metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-METRIC - Retrieve
Retrieve operation of resource: interface-metric
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delay": "integer", Delay metric, in 10 microsecond units\n(default) or picosecond units
range: "1..4294967295"
"load": "integer", Effective bandwidth metric (Loading) where\n255 is 100% loaded
range: "1..255"
"bandwidth": "integer", Bandwidth in Kbits per second
range: "1..4294967295"
units: "kbit/s"
"reliability": "integer", Reliability metric where 255 is 100% reliable
range: "0..255"
"delay-unit": "enumeration" Delay unit
Options:
ten-microsecond
picosecond
}
}
REMOTE-NEIGHBOR - Update
Update operation of resource: remote-neighbor
remote-neighborbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Create
Create operation of resource: remote-neighbor
remote-neighborbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Delete
Delete operation of resource: remote-neighbor
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-NEIGHBOR - Retrieve
Retrieve operation of resource: remote-neighbor
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
BFD - Update
Update operation of resource: bfd
bfdbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "fast-detect": "boolean", Enable BFD fast detection
"detection-multiplier": "integer", Detect multiplier
range: "2..50"
"interval": "integer" Hello interval in milli-seconds
range: "15..3000"
units: "millisecond"
}
}
SITE-OF-ORIGIN - Update
Update operation of resource: site-of-origin
site-of-originbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Create
Create operation of resource: site-of-origin
site-of-originbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Delete
Delete operation of resource: site-of-origin
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SITE-OF-ORIGIN - Retrieve
Retrieve operation of resource: site-of-origin
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", AS Number Index
range: "0..4294967295"
"as-xx": "integer", Higher sixteen bits of 4-byte BGP AS Number
range: "0..65535"
"address-index": "integer", IPv4 address index
range: "0..65535"
"as-yy": "integer", 2-byte or 4-byte BGP AS Number
range: "0..4294967295"
"address": "string", IPv4 address
"type": "enumeration" SoO type
Options:
as
ipv4-address
four-byte-as
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
SUMMARY-ADDRESSES - Update
Update operation of resource: summary-addresses
summary-addressesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Create
Create operation of resource: summary-addresses
summary-addressesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Delete
Delete operation of resource: summary-addresses
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESSES - Retrieve
Retrieve operation of resource: summary-addresses
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
]
}
}
SUMMARY-ADDRESS - Update
Update operation of resource: summary-address
summary-addressbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
Request Content-Types: application/json
Request Example
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Create
Create operation of resource: summary-address
summary-addressbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
Request Content-Types: application/json
Request Example
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Delete
Delete operation of resource: summary-address
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-ADDRESS - Retrieve
Retrieve operation of resource: summary-address
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
summary-address-addr summary-address-prefix:
string
in path
ID of summary-address-addr summary-address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "distance": "integer", Administrative distance
range: "1..255"
"summary-address-prefix": "integer", Summary Prefix (prefix part)
range: "0..128"
"summary-address-addr": "string" Summary Prefix (address part)
}
}
INTERFACE-FILTER-POLICIES - Update
Update operation of resource: interface-filter-policies
interface-filter-policiesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Create
Create operation of resource: interface-filter-policies
interface-filter-policiesbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Delete
Delete operation of resource: interface-filter-policies
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICIES - Retrieve
Retrieve operation of resource: interface-filter-policies
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
INTERFACE-FILTER-POLICY - Update
Update operation of resource: interface-filter-policy
interface-filter-policybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Create
Create operation of resource: interface-filter-policy
interface-filter-policybody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Delete
Delete operation of resource: interface-filter-policy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-FILTER-POLICY - Retrieve
Retrieve operation of resource: interface-filter-policy
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
direction:
string
in path
ID of direction
Successful operation
400 Bad Request
Internal Error
INTERFACE-STATIC-NEIGHBORS - Update
Update operation of resource: interface-static-neighbors
interface-static-neighborsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Create
Create operation of resource: interface-static-neighbors
interface-static-neighborsbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Delete
Delete operation of resource: interface-static-neighbors
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBORS - Retrieve
Retrieve operation of resource: interface-static-neighbors
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
INTERFACE-STATIC-NEIGHBOR - Update
Update operation of resource: interface-static-neighbor
interface-static-neighborbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Create
Create operation of resource: interface-static-neighbor
interface-static-neighborbody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Delete
Delete operation of resource: interface-static-neighbor
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE-STATIC-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-static-neighbor
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
DISTANCE - Update
Update operation of resource: distance
distancebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Create
Create operation of resource: distance
distancebody object
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Delete
Delete operation of resource: distance
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DISTANCE - Retrieve
Retrieve operation of resource: distance
process-id:
string
in path
ID of process-id
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error